\hypertarget{_a_d_s1256___driver_8c}{\section{A\-D\-S1256\-\_\-\-Driver.\-c File Reference}
\label{_a_d_s1256___driver_8c}\index{A\-D\-S1256\-\_\-\-Driver.\-c@{A\-D\-S1256\-\_\-\-Driver.\-c}}
}


Controls the A\-D\-S1256 A\-D\-C via S\-P\-I.  


{\ttfamily \#include \char`\"{}Tekdaqc\-\_\-\-Debug.\-h\char`\"{}}\\*
{\ttfamily \#include \char`\"{}A\-D\-S1256\-\_\-\-Driver.\-h\char`\"{}}\\*
{\ttfamily \#include \char`\"{}Tekdaqc\-\_\-\-Config.\-h\char`\"{}}\\*
{\ttfamily \#include \char`\"{}Tekdaqc\-\_\-\-Timers.\-h\char`\"{}}\\*
{\ttfamily \#include $<$string.\-h$>$}\\*
{\ttfamily \#include $<$stdlib.\-h$>$}\\*
\subsection*{Macros}
\begin{DoxyCompactItemize}
\item 
\#define \hyperlink{_a_d_s1256___driver_8c_a04429776ba95839668cd3af623650e87}{A\-D\-S1256\-\_\-\-N\-E\-G\-A\-T\-I\-V\-E\-\_\-\-F\-L\-A\-G}~((uint32\-\_\-t) 0x00800000\-U)
\begin{DoxyCompactList}\small\item\em Used to identify if a 24 bit unsigned int stored in a 32 bit unsigned int represents 2's compliment negative. \end{DoxyCompactList}\item 
\#define \hyperlink{_a_d_s1256___driver_8c_ab81fe3f8a82390e44e042f351df3f59c}{A\-D\-S1256\-\_\-\-N\-E\-G\-A\-T\-I\-V\-E\-\_\-\-P\-A\-D\-D\-I\-N\-G}~((uint32\-\_\-t) 0x\-F\-F000000\-U)
\begin{DoxyCompactList}\small\item\em Used to pad a 24 bit unsigned int which represents a 2's compliment negative number to a 32 bit int. \end{DoxyCompactList}\item 
\#define \hyperlink{_a_d_s1256___driver_8c_a09f71f7cdf36c3dee470ee38edc8431e}{A\-D\-S1256\-\_\-\-R\-E\-G\-I\-S\-T\-E\-R\-S\-\_\-\-D\-E\-B\-U\-G\-\_\-\-F\-O\-R\-M\-A\-T\-T\-E\-R}~\char`\"{}\mbox{[}A\-D\-S1256\mbox{]} Register \%2d \%6s\-: 0x\%02\-X\textbackslash{}n\textbackslash{}r\char`\"{}
\begin{DoxyCompactList}\small\item\em Used as the format string for printing the A\-D\-S1256 registers to a string. \end{DoxyCompactList}\item 
\#define \hyperlink{_a_d_s1256___driver_8c_aaa23b199dae1b52d4b78b56328e5509b}{A\-D\-S1256\-\_\-\-R\-E\-G\-I\-S\-T\-E\-R\-S\-\_\-\-T\-O\-S\-T\-R\-I\-N\-G\-\_\-\-H\-E\-A\-D\-E\-R}~\char`\"{}\mbox{[}A\-D\-S1256\mbox{]} Register Contents\-:\textbackslash{}n\textbackslash{}r\char`\"{}
\begin{DoxyCompactList}\small\item\em Used as a header for each block of analog measurement printing to string. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item 
void \hyperlink{group__ads1256__driver_ga817dc23392ce56ae255cb3238d796b60}{A\-D\-S1256\-\_\-\-Init} (void)
\begin{DoxyCompactList}\small\item\em Initialize the A\-D\-S1256 A\-D\-C Driver. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_gac1a6ea86db094b51ec478098738353b4}{A\-D\-S1256\-\_\-\-State\-Pins\-\_\-\-Init} (void)
\begin{DoxyCompactList}\small\item\em Initialize the state pins of the A\-D\-C Driver. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_ga9642423b95878836291bbf57102e92a6}{A\-D\-S1256\-\_\-\-Print\-Regs} (void)
\begin{DoxyCompactList}\small\item\em Print all the local registers. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_gacbbff85197a622b07cfb2bf47b57c29b}{A\-D\-S1256\-\_\-\-Registers\-To\-String} (void)
\begin{DoxyCompactList}\small\item\em Print all the local registers to a string. \end{DoxyCompactList}\item 
const char $\ast$ \hyperlink{group__ads1256__driver_gabfd8ef639770cdb94388e1b63da1b0ba}{A\-D\-S1256\-\_\-\-String\-From\-S\-P\-S} (\hyperlink{group__ads1256__driver_gab0437f81aad031aadf3e05dd5fe0a731}{A\-D\-S1256\-\_\-\-S\-P\-S\-\_\-t} sps)
\begin{DoxyCompactList}\small\item\em Return the human readable string representation of the provided data rate. \end{DoxyCompactList}\item 
const char $\ast$ \hyperlink{group__ads1256__driver_ga59c2fb71d5fac95ab30f4c66c0e4a9e2}{A\-D\-S1256\-\_\-\-String\-From\-P\-G\-A} (\hyperlink{group__ads1256__driver_gace2e231df7cd3598eb26d5ff51171701}{A\-D\-S1256\-\_\-\-P\-G\-A\-\_\-t} pga)
\begin{DoxyCompactList}\small\item\em Return the human readable string representation of the provided gain setting. \end{DoxyCompactList}\item 
const char $\ast$ \hyperlink{group__ads1256__driver_gafab91604ac5588b9c626bb7e050f0774}{A\-D\-S1256\-\_\-\-String\-From\-Buffer} (\hyperlink{group__ads1256__driver_ga12f71f8fc93fe63fb3c855ddd2070890}{A\-D\-S1256\-\_\-\-B\-U\-F\-F\-E\-R\-\_\-t} buffer)
\begin{DoxyCompactList}\small\item\em Return the human readable string representation of the provided buffer setting. \end{DoxyCompactList}\item 
\hyperlink{group__ads1256__driver_ga12f71f8fc93fe63fb3c855ddd2070890}{A\-D\-S1256\-\_\-\-B\-U\-F\-F\-E\-R\-\_\-t} \hyperlink{group__ads1256__driver_gac39cc4f0a18e9f7ce3f915d5b5050d94}{A\-D\-S1256\-\_\-\-String\-To\-Buffer} (char $\ast$str)
\begin{DoxyCompactList}\small\item\em Convert a human readable string into the relevant A\-D\-S1256\-\_\-\-B\-U\-F\-F\-E\-R\-\_\-t value. \end{DoxyCompactList}\item 
\hyperlink{group__ads1256__driver_gab0437f81aad031aadf3e05dd5fe0a731}{A\-D\-S1256\-\_\-\-S\-P\-S\-\_\-t} \hyperlink{group__ads1256__driver_gae2f1be4b151cfc9dfeede38a79764dff}{A\-D\-S1256\-\_\-\-String\-To\-Data\-Rate} (char $\ast$str)
\begin{DoxyCompactList}\small\item\em Convert a human readable string into the relevant A\-D\-S1256\-\_\-\-S\-P\-S\-\_\-t value. \end{DoxyCompactList}\item 
\hyperlink{group__ads1256__driver_gace2e231df7cd3598eb26d5ff51171701}{A\-D\-S1256\-\_\-\-P\-G\-A\-\_\-t} \hyperlink{group__ads1256__driver_ga04cf21f06b462886045c4075782fdf13}{A\-D\-S1256\-\_\-\-String\-To\-P\-G\-A} (char $\ast$str)
\begin{DoxyCompactList}\small\item\em Convert a human readable string into the relevant A\-D\-S1256\-\_\-\-P\-G\-A\-\_\-t value. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_ga7b012a2ab6b0494da4e1297e34ab9925}{A\-D\-S1256\-\_\-\-Full\-\_\-\-Reset} (void)
\begin{DoxyCompactList}\small\item\em Completely reset the A\-D\-S1256 A\-D\-C. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_gafdd4555dcde566f72adf2d9d51f4a883}{A\-D\-S1256\-\_\-\-Reset\-\_\-\-By\-\_\-\-Command} (void)
\begin{DoxyCompactList}\small\item\em Reset the A\-D\-S1256 A\-D\-C via S\-P\-I command. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_ga1c25b603705f67cccde59e406b1c4c07}{A\-D\-S1256\-\_\-\-Reset\-\_\-\-By\-\_\-\-Clock} (void)
\begin{DoxyCompactList}\small\item\em Reset the A\-D\-S1256 A\-D\-C via clock command. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_ga4664ba6707817673019016b0b0d6668e}{A\-D\-S1256\-\_\-\-Reset\-\_\-\-By\-\_\-\-Pin} (void)
\begin{DoxyCompactList}\small\item\em Reset the A\-D\-S1256 A\-D\-C via its R\-E\-S\-E\-T pin. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_ga5fb186f2113df3c976ae00debb6095d7}{A\-D\-S1256\-\_\-\-Reset\-\_\-\-S\-P\-I} (void)
\begin{DoxyCompactList}\small\item\em Reset the A\-D\-S1256 A\-D\-C S\-P\-I port. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_ga16dbb214bb63f6051170ee4f8964beb6}{A\-D\-S1256\-\_\-\-Reset\-And\-Reprogram} (void)
\begin{DoxyCompactList}\small\item\em Performs a complete reset of the A\-D\-S1256 and restores its state. \end{DoxyCompactList}\item 
int32\-\_\-t \hyperlink{group__ads1256__driver_ga7dee6663af668f862c4bca7c56d80f5e}{A\-D\-S1256\-\_\-\-Get\-Measurement} (void)
\begin{DoxyCompactList}\small\item\em Retrieve the latest measurement code from the A\-D\-C. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_gaa44ba74c5036ac42b24ce84eafaf56f2}{A\-D\-S1256\-\_\-\-Request\-Measurement} (void)
\begin{DoxyCompactList}\small\item\em Initiate a measurement. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_ga91d8582f9d5cb52b54fb801644e05e21}{A\-D\-S1256\-\_\-\-Read\-Data} (uint8\-\_\-t $\ast$data)
\begin{DoxyCompactList}\small\item\em Start reading the 3-\/byte data. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_ga458c5bdb28d0e87e28cdaa9cfcd5f429}{A\-D\-S1256\-\_\-\-Wait\-Until\-Data\-Ready} (\hyperlink{group__data__types_ga0ecf26b576b9a54eca656b9be7ba6a06}{bool} use\-Command)
\begin{DoxyCompactList}\small\item\em Wait in a loop until data is ready. \end{DoxyCompactList}\item 
\hyperlink{group__data__types_ga0ecf26b576b9a54eca656b9be7ba6a06}{bool} \hyperlink{group__ads1256__driver_gafa9381054942c98cb2be8881e86bc209}{A\-D\-S1256\-\_\-\-Is\-Data\-Ready} (\hyperlink{group__data__types_ga0ecf26b576b9a54eca656b9be7ba6a06}{bool} use\-Command)
\begin{DoxyCompactList}\small\item\em Checks to see if valid data is ready. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_ga612ca0b8927aa0580401813ee278348b}{A\-D\-S1256\-\_\-\-Sync} (\hyperlink{group__data__types_ga0ecf26b576b9a54eca656b9be7ba6a06}{bool} use\-Command)
\begin{DoxyCompactList}\small\item\em Activate the S\-Y\-N\-C feature of the A\-D\-C. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_ga2388b60ca886620f0daba1efc69c940a}{A\-D\-S1256\-\_\-\-Wakeup} (void)
\begin{DoxyCompactList}\small\item\em Wakeup the A\-D\-C from S\-Y\-N\-C/\-P\-W\-D\-N. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_ga5a915f192a268c5737f34dcbe2859524}{A\-D\-S1256\-\_\-\-Standby} (void)
\begin{DoxyCompactList}\small\item\em Put the A\-D\-C into S\-T\-A\-N\-D\-B\-Y mode. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_ga72de73cf9585121dd65895c6addf16ff}{A\-D\-S1256\-\_\-\-Calibrate\-Self} (void)
\begin{DoxyCompactList}\small\item\em Performs a complete self calibration of the A\-D\-C. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_ga96e7231f5e5efc15c39b81b21baf1b95}{A\-D\-S1256\-\_\-\-Calibrate\-Self\-\_\-\-Gain} (void)
\begin{DoxyCompactList}\small\item\em Performs a self gain calibration of the A\-D\-C. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_ga16aea61ac77485fb889c960e16b0ed6b}{A\-D\-S1256\-\_\-\-Calibrate\-Self\-\_\-\-Offset} (void)
\begin{DoxyCompactList}\small\item\em Performs a self offset calibration of the A\-D\-C. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_ga46a14d9bcba054e6b6db5b4f8f0bf895}{A\-D\-S1256\-\_\-\-Calibrate\-System\-\_\-\-Gain} (void)
\begin{DoxyCompactList}\small\item\em Performs a system gain calibration. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_gab49754dd631e07c61fed6c41b18ad88e}{A\-D\-S1256\-\_\-\-Calibrate\-System\-\_\-\-Offset} (void)
\begin{DoxyCompactList}\small\item\em Performs a system offset calibration. \end{DoxyCompactList}\item 
int32\-\_\-t \hyperlink{group__ads1256__driver_gad8605a86bb12367efea3074b97dfa529}{A\-D\-S1256\-\_\-\-Convert\-Raw\-Value} (uint32\-\_\-t value)
\begin{DoxyCompactList}\small\item\em Converts the raw output of the A\-D\-C into a signed integer type. \end{DoxyCompactList}\item 
float \hyperlink{group__ads1256__driver_ga4a1749dfc2cad3986a2f29cbe6e63b87}{A\-D\-S1256\-\_\-\-Get\-Self\-Cal\-Time} (void)
\begin{DoxyCompactList}\small\item\em Retrieves the total self calibration time. \end{DoxyCompactList}\item 
float \hyperlink{group__ads1256__driver_ga2628d1ea4f1436c89584bcc47baf79ef}{A\-D\-S1256\-\_\-\-Get\-Offset\-Cal\-Time} (void)
\begin{DoxyCompactList}\small\item\em Retrieves the self offset calibration time. \end{DoxyCompactList}\item 
float \hyperlink{group__ads1256__driver_ga041017c82a9411b72436c29667e98960}{A\-D\-S1256\-\_\-\-Get\-Self\-Gain\-Cal\-Time} (void)
\begin{DoxyCompactList}\small\item\em Retrieves the self gain calibration time. \end{DoxyCompactList}\item 
float \hyperlink{group__ads1256__driver_ga429559f049274cd24a6be2b20fd82973}{A\-D\-S1256\-\_\-\-Get\-System\-Gain\-Cal\-Time} (void)
\begin{DoxyCompactList}\small\item\em Retrieves the total system calibration time. \end{DoxyCompactList}\item 
float \hyperlink{group__ads1256__driver_ga5cb8add9c1b77b2cf87be526d6363d1c}{A\-D\-S1256\-\_\-\-Get\-Settling\-Time} (void)
\begin{DoxyCompactList}\small\item\em Retrieves the settling time of the A\-D\-C. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_gad426414f0eab896faac18f0c6d4dbaa2}{A\-D\-S1256\-\_\-\-Alway\-Fetch} (\hyperlink{group__data__types_ga0ecf26b576b9a54eca656b9be7ba6a06}{bool} always)
\begin{DoxyCompactList}\small\item\em Selects remote register auto-\/fetch behavior. \end{DoxyCompactList}\item 
uint8\-\_\-t \hyperlink{group__ads1256__driver_gaec26aa231ee327bf65220eee6f779b81}{A\-D\-S1256\-\_\-\-Get\-Factory\-Programmed\-I\-D} (void)
\begin{DoxyCompactList}\small\item\em Retrieves the factory programed I\-D of the A\-D\-C. \end{DoxyCompactList}\item 
\hyperlink{group__ads1256__driver_ga3615e2e1ba70971dcdd5f7e54ffe5606}{A\-D\-S1256\-\_\-\-O\-R\-D\-E\-R\-\_\-t} \hyperlink{group__ads1256__driver_ga6f362fc42d375f4aec10bd2115dfd85d}{A\-D\-S1256\-\_\-\-Get\-Data\-Output\-Bit\-Order} (void)
\begin{DoxyCompactList}\small\item\em Retrieves the current data output order. \end{DoxyCompactList}\item 
\hyperlink{group__ads1256__driver_ga17864ca559c443a262068f0d19406113}{A\-D\-S1256\-\_\-\-A\-C\-A\-L\-\_\-t} \hyperlink{group__ads1256__driver_ga3a4dac1ff9bffcccbc561853a9598554}{A\-D\-S1256\-\_\-\-Get\-Auto\-Cal\-Setting} (void)
\begin{DoxyCompactList}\small\item\em Retrieves the current auto calibration setting. \end{DoxyCompactList}\item 
\hyperlink{group__ads1256__driver_ga12f71f8fc93fe63fb3c855ddd2070890}{A\-D\-S1256\-\_\-\-B\-U\-F\-F\-E\-R\-\_\-t} \hyperlink{group__ads1256__driver_gafb6c3c92ef11b050dfa33073e0347a4c}{A\-D\-S1256\-\_\-\-Get\-Input\-Buffer\-Setting} (void)
\begin{DoxyCompactList}\small\item\em Retrieves the current input buffer setting. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_ga4131f935614bc1ea9eff4f0ec8b1cdfb}{A\-D\-S1256\-\_\-\-Set\-Data\-Output\-Bit\-Order} (\hyperlink{group__ads1256__driver_ga3615e2e1ba70971dcdd5f7e54ffe5606}{A\-D\-S1256\-\_\-\-O\-R\-D\-E\-R\-\_\-t} order)
\begin{DoxyCompactList}\small\item\em Sets the data output order. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_ga7dbd4e23a723295a60adc8a7a97b9c5a}{A\-D\-S1256\-\_\-\-Set\-Auto\-Cal\-Setting} (\hyperlink{group__ads1256__driver_ga17864ca559c443a262068f0d19406113}{A\-D\-S1256\-\_\-\-A\-C\-A\-L\-\_\-t} acal)
\begin{DoxyCompactList}\small\item\em Sets the auto calibration setting. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_ga0d74a1bb54e74bd1ef8af302471d3905}{A\-D\-S1256\-\_\-\-Set\-Input\-Buffer\-Setting} (\hyperlink{group__ads1256__driver_ga12f71f8fc93fe63fb3c855ddd2070890}{A\-D\-S1256\-\_\-\-B\-U\-F\-F\-E\-R\-\_\-t} buffer)
\begin{DoxyCompactList}\small\item\em Sets the input buffer setting. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_ga9b6a25919b727c6e438f8bddf36f10b0}{A\-D\-S1256\-\_\-\-Get\-Input\-Channels} (void)
\begin{DoxyCompactList}\small\item\em Retrieve the currently selected input channels. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_ga2bf7d5627d8645de8b27842a006653bd}{A\-D\-S1256\-\_\-\-Set\-Input\-Channels} (\hyperlink{group__ads1256__driver_ga7eac069c538033668b7baeca198def8f}{A\-D\-S1256\-\_\-\-A\-I\-N\-\_\-t} pos, \hyperlink{group__ads1256__driver_ga7eac069c538033668b7baeca198def8f}{A\-D\-S1256\-\_\-\-A\-I\-N\-\_\-t} neg)
\begin{DoxyCompactList}\small\item\em Set the currently selected input channels. \end{DoxyCompactList}\item 
\hyperlink{group__ads1256__driver_ga2d683909a58aa0617ee7c5d06d0a489f}{A\-D\-S1256\-\_\-\-C\-L\-O\-C\-K\-\_\-\-O\-U\-T\-\_\-t} \hyperlink{group__ads1256__driver_ga047a9418e182cce649f167169e3a72bf}{A\-D\-S1256\-\_\-\-Get\-Clock\-Out\-Rate} (void)
\begin{DoxyCompactList}\small\item\em Retrieve the A\-D\-C clock out rate. \end{DoxyCompactList}\item 
\hyperlink{group__ads1256__driver_gaa3102e98865ba4e72463676779cd62d4}{A\-D\-S1256\-\_\-\-S\-E\-N\-S\-O\-R\-\_\-\-D\-E\-T\-E\-C\-T\-\_\-t} \hyperlink{group__ads1256__driver_ga7ce3f5d5b256eeeba15bd2ad17c1010a}{A\-D\-S1256\-\_\-\-Get\-Sensor\-Detect\-Current} (void)
\item 
\hyperlink{group__ads1256__driver_gace2e231df7cd3598eb26d5ff51171701}{A\-D\-S1256\-\_\-\-P\-G\-A\-\_\-t} \hyperlink{group__ads1256__driver_gab8cdcd9e7ab992e068f8b008c138f4e1}{A\-D\-S1256\-\_\-\-Get\-P\-G\-A\-Setting} (void)
\begin{DoxyCompactList}\small\item\em Retrieve the A\-D\-C P\-G\-A gain setting. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_ga8354e6ff9be09b89afcac3c5fcbd3083}{A\-D\-S1256\-\_\-\-Set\-Clock\-Out\-Rate} (\hyperlink{group__ads1256__driver_ga2d683909a58aa0617ee7c5d06d0a489f}{A\-D\-S1256\-\_\-\-C\-L\-O\-C\-K\-\_\-\-O\-U\-T\-\_\-t} clock)
\begin{DoxyCompactList}\small\item\em Set the A\-D\-C clock out rate. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_gae179dd8d2feace96c296cdff466225dc}{A\-D\-S1256\-\_\-\-Set\-Sensor\-Detect\-Current} (\hyperlink{group__ads1256__driver_gaa3102e98865ba4e72463676779cd62d4}{A\-D\-S1256\-\_\-\-S\-E\-N\-S\-O\-R\-\_\-\-D\-E\-T\-E\-C\-T\-\_\-t} current)
\begin{DoxyCompactList}\small\item\em Set the A\-D\-C sensor detect current output. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_gabd0d17a03fdddefb2d8cf04ad304a49d}{A\-D\-S1256\-\_\-\-Set\-P\-G\-A\-Setting} (\hyperlink{group__ads1256__driver_gace2e231df7cd3598eb26d5ff51171701}{A\-D\-S1256\-\_\-\-P\-G\-A\-\_\-t} gain)
\begin{DoxyCompactList}\small\item\em Set the A\-D\-C P\-G\-A gain setting. \end{DoxyCompactList}\item 
int32\-\_\-t \hyperlink{group__ads1256__driver_ga853d2d710efae91bb12c6cb17d562459}{A\-D\-S1256\-\_\-\-Get\-Gain\-Multiplier} (\hyperlink{group__ads1256__driver_gace2e231df7cd3598eb26d5ff51171701}{A\-D\-S1256\-\_\-\-P\-G\-A\-\_\-t} gain)
\begin{DoxyCompactList}\small\item\em Retrieve the multiplier for a specific P\-G\-A setting. \end{DoxyCompactList}\item 
\hyperlink{group__ads1256__driver_gab0437f81aad031aadf3e05dd5fe0a731}{A\-D\-S1256\-\_\-\-S\-P\-S\-\_\-t} \hyperlink{group__ads1256__driver_gacf2f61cb43087ae7c270f00d24b27526}{A\-D\-S1256\-\_\-\-Get\-Data\-Rate} (void)
\begin{DoxyCompactList}\small\item\em Retrieve the A\-D\-C data rate (sample rate) setting. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_ga14de02499be3d1dae8497b4e048b9568}{A\-D\-S1256\-\_\-\-Set\-Data\-Rate} (\hyperlink{group__ads1256__driver_gab0437f81aad031aadf3e05dd5fe0a731}{A\-D\-S1256\-\_\-\-S\-P\-S\-\_\-t} sps)
\begin{DoxyCompactList}\small\item\em Set the A\-D\-C data rate (sample rate) setting. \end{DoxyCompactList}\item 
\hyperlink{group__ads1256__driver_ga4df06f2662792cc9eff4ac7f97e35026}{A\-D\-S1256\-\_\-\-G\-P\-I\-O\-\_\-\-D\-I\-R\-E\-C\-T\-I\-O\-N\-\_\-t} \hyperlink{group__ads1256__driver_gacc11f35703f43c395edb1e56c93d707f}{A\-D\-S1256\-\_\-\-Get\-G\-P\-I\-O\-Direction} (\hyperlink{group__ads1256__driver_gaf55f2ff09e67223f3e5e0a6eb69de98b}{A\-D\-S1256\-\_\-\-G\-P\-I\-O\-\_\-t} pin)
\begin{DoxyCompactList}\small\item\em Retrieve the G\-P\-I\-O direction setting of a pin. \end{DoxyCompactList}\item 
\hyperlink{group__ads1256__driver_ga587084017ba4b239ffb8d90376921c2c}{A\-D\-S1256\-\_\-\-G\-P\-I\-O\-\_\-\-S\-T\-A\-T\-U\-S\-\_\-t} \hyperlink{group__ads1256__driver_gaf864f2f518cd80873993a8f2ca073e27}{A\-D\-S1256\-\_\-\-Get\-G\-P\-I\-O\-Status} (\hyperlink{group__ads1256__driver_gaf55f2ff09e67223f3e5e0a6eb69de98b}{A\-D\-S1256\-\_\-\-G\-P\-I\-O\-\_\-t} pin)
\begin{DoxyCompactList}\small\item\em Retrieve the current state of a G\-P\-I\-O pin. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_gacea1f1adb429508088a4a32029f90d00}{A\-D\-S1256\-\_\-\-Set\-G\-P\-I\-O\-Direction} (\hyperlink{group__ads1256__driver_gaf55f2ff09e67223f3e5e0a6eb69de98b}{A\-D\-S1256\-\_\-\-G\-P\-I\-O\-\_\-t} pin, \hyperlink{group__ads1256__driver_ga4df06f2662792cc9eff4ac7f97e35026}{A\-D\-S1256\-\_\-\-G\-P\-I\-O\-\_\-\-D\-I\-R\-E\-C\-T\-I\-O\-N\-\_\-t} direction)
\begin{DoxyCompactList}\small\item\em Set the G\-P\-I\-O direction setting of a pin. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_ga3285b54e967fbb817f071f9a1c455920}{A\-D\-S1256\-\_\-\-Set\-G\-P\-I\-O\-Status} (\hyperlink{group__ads1256__driver_gaf55f2ff09e67223f3e5e0a6eb69de98b}{A\-D\-S1256\-\_\-\-G\-P\-I\-O\-\_\-t} pin, \hyperlink{group__ads1256__driver_ga587084017ba4b239ffb8d90376921c2c}{A\-D\-S1256\-\_\-\-G\-P\-I\-O\-\_\-\-S\-T\-A\-T\-U\-S\-\_\-t} status)
\begin{DoxyCompactList}\small\item\em Set the state of a G\-P\-I\-O pin. \end{DoxyCompactList}\item 
uint32\-\_\-t \hyperlink{group__ads1256__driver_ga63ad5ddbb824fd07aedb6c0884db47eb}{A\-D\-S1256\-\_\-\-Get\-Offset\-Cal\-Setting} (void)
\begin{DoxyCompactList}\small\item\em Retrieve the current offset calibration value. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_ga420b194968282731c912be5ccad0d30c}{A\-D\-S1256\-\_\-\-Set\-Offset\-Cal\-Setting} (uint8\-\_\-t $\ast$value)
\begin{DoxyCompactList}\small\item\em Set the offset calibration value. \end{DoxyCompactList}\item 
uint32\-\_\-t \hyperlink{group__ads1256__driver_ga06c5d4c98c45514224e4f494b2618221}{A\-D\-S1256\-\_\-\-Get\-Gain\-Cal\-Setting} (void)
\begin{DoxyCompactList}\small\item\em Retrieve the current gain calibration value. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_ga87d92ada1f9826aabe9e4b330e9edbef}{A\-D\-S1256\-\_\-\-Set\-Gain\-Cal\-Setting} (uint8\-\_\-t $\ast$value)
\begin{DoxyCompactList}\small\item\em Set the gain calibration value. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_ga525f292542208f8309ee79c912b77334}{A\-D\-S1256\-\_\-\-S\-C\-L\-K\-\_\-\-L\-O\-W} (void)
\begin{DoxyCompactList}\small\item\em Send the S\-P\-I Clock pin low. \end{DoxyCompactList}\item 
void \hyperlink{group__ads1256__driver_ga13b51a0fb626ff6f592fc7ce425e8046}{A\-D\-S1256\-\_\-\-S\-C\-L\-K\-\_\-\-H\-I\-G\-H} (void)
\begin{DoxyCompactList}\small\item\em Send the S\-P\-I Clock pin high. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
Controls the A\-D\-S1256 A\-D\-C via S\-P\-I. This driver retains a local copy of all of the devices registers which can be used selectively.

\begin{DoxyAuthor}{Author}
Jared Woolston (\href{mailto:jwoolston@tenkiv.com}{\tt jwoolston@tenkiv.\-com}) 
\end{DoxyAuthor}
\begin{DoxySince}{Since}
v1.\-0.\-0.\-0 
\end{DoxySince}


Definition in file \hyperlink{_a_d_s1256___driver_8c_source}{A\-D\-S1256\-\_\-\-Driver.\-c}.



\subsection{Macro Definition Documentation}
\hypertarget{_a_d_s1256___driver_8c_a04429776ba95839668cd3af623650e87}{\index{A\-D\-S1256\-\_\-\-Driver.\-c@{A\-D\-S1256\-\_\-\-Driver.\-c}!A\-D\-S1256\-\_\-\-N\-E\-G\-A\-T\-I\-V\-E\-\_\-\-F\-L\-A\-G@{A\-D\-S1256\-\_\-\-N\-E\-G\-A\-T\-I\-V\-E\-\_\-\-F\-L\-A\-G}}
\index{A\-D\-S1256\-\_\-\-N\-E\-G\-A\-T\-I\-V\-E\-\_\-\-F\-L\-A\-G@{A\-D\-S1256\-\_\-\-N\-E\-G\-A\-T\-I\-V\-E\-\_\-\-F\-L\-A\-G}!ADS1256_Driver.c@{A\-D\-S1256\-\_\-\-Driver.\-c}}
\subsubsection[{A\-D\-S1256\-\_\-\-N\-E\-G\-A\-T\-I\-V\-E\-\_\-\-F\-L\-A\-G}]{\setlength{\rightskip}{0pt plus 5cm}\#define A\-D\-S1256\-\_\-\-N\-E\-G\-A\-T\-I\-V\-E\-\_\-\-F\-L\-A\-G~((uint32\-\_\-t) 0x00800000\-U)}}\label{_a_d_s1256___driver_8c_a04429776ba95839668cd3af623650e87}


Definition at line 51 of file A\-D\-S1256\-\_\-\-Driver.\-c.

\hypertarget{_a_d_s1256___driver_8c_ab81fe3f8a82390e44e042f351df3f59c}{\index{A\-D\-S1256\-\_\-\-Driver.\-c@{A\-D\-S1256\-\_\-\-Driver.\-c}!A\-D\-S1256\-\_\-\-N\-E\-G\-A\-T\-I\-V\-E\-\_\-\-P\-A\-D\-D\-I\-N\-G@{A\-D\-S1256\-\_\-\-N\-E\-G\-A\-T\-I\-V\-E\-\_\-\-P\-A\-D\-D\-I\-N\-G}}
\index{A\-D\-S1256\-\_\-\-N\-E\-G\-A\-T\-I\-V\-E\-\_\-\-P\-A\-D\-D\-I\-N\-G@{A\-D\-S1256\-\_\-\-N\-E\-G\-A\-T\-I\-V\-E\-\_\-\-P\-A\-D\-D\-I\-N\-G}!ADS1256_Driver.c@{A\-D\-S1256\-\_\-\-Driver.\-c}}
\subsubsection[{A\-D\-S1256\-\_\-\-N\-E\-G\-A\-T\-I\-V\-E\-\_\-\-P\-A\-D\-D\-I\-N\-G}]{\setlength{\rightskip}{0pt plus 5cm}\#define A\-D\-S1256\-\_\-\-N\-E\-G\-A\-T\-I\-V\-E\-\_\-\-P\-A\-D\-D\-I\-N\-G~((uint32\-\_\-t) 0x\-F\-F000000\-U)}}\label{_a_d_s1256___driver_8c_ab81fe3f8a82390e44e042f351df3f59c}


Definition at line 58 of file A\-D\-S1256\-\_\-\-Driver.\-c.

\hypertarget{_a_d_s1256___driver_8c_a09f71f7cdf36c3dee470ee38edc8431e}{\index{A\-D\-S1256\-\_\-\-Driver.\-c@{A\-D\-S1256\-\_\-\-Driver.\-c}!A\-D\-S1256\-\_\-\-R\-E\-G\-I\-S\-T\-E\-R\-S\-\_\-\-D\-E\-B\-U\-G\-\_\-\-F\-O\-R\-M\-A\-T\-T\-E\-R@{A\-D\-S1256\-\_\-\-R\-E\-G\-I\-S\-T\-E\-R\-S\-\_\-\-D\-E\-B\-U\-G\-\_\-\-F\-O\-R\-M\-A\-T\-T\-E\-R}}
\index{A\-D\-S1256\-\_\-\-R\-E\-G\-I\-S\-T\-E\-R\-S\-\_\-\-D\-E\-B\-U\-G\-\_\-\-F\-O\-R\-M\-A\-T\-T\-E\-R@{A\-D\-S1256\-\_\-\-R\-E\-G\-I\-S\-T\-E\-R\-S\-\_\-\-D\-E\-B\-U\-G\-\_\-\-F\-O\-R\-M\-A\-T\-T\-E\-R}!ADS1256_Driver.c@{A\-D\-S1256\-\_\-\-Driver.\-c}}
\subsubsection[{A\-D\-S1256\-\_\-\-R\-E\-G\-I\-S\-T\-E\-R\-S\-\_\-\-D\-E\-B\-U\-G\-\_\-\-F\-O\-R\-M\-A\-T\-T\-E\-R}]{\setlength{\rightskip}{0pt plus 5cm}\#define A\-D\-S1256\-\_\-\-R\-E\-G\-I\-S\-T\-E\-R\-S\-\_\-\-D\-E\-B\-U\-G\-\_\-\-F\-O\-R\-M\-A\-T\-T\-E\-R~\char`\"{}\mbox{[}A\-D\-S1256\mbox{]} Register \%2d \%6s\-: 0x\%02\-X\textbackslash{}n\textbackslash{}r\char`\"{}}}\label{_a_d_s1256___driver_8c_a09f71f7cdf36c3dee470ee38edc8431e}


Definition at line 72 of file A\-D\-S1256\-\_\-\-Driver.\-c.

\hypertarget{_a_d_s1256___driver_8c_aaa23b199dae1b52d4b78b56328e5509b}{\index{A\-D\-S1256\-\_\-\-Driver.\-c@{A\-D\-S1256\-\_\-\-Driver.\-c}!A\-D\-S1256\-\_\-\-R\-E\-G\-I\-S\-T\-E\-R\-S\-\_\-\-T\-O\-S\-T\-R\-I\-N\-G\-\_\-\-H\-E\-A\-D\-E\-R@{A\-D\-S1256\-\_\-\-R\-E\-G\-I\-S\-T\-E\-R\-S\-\_\-\-T\-O\-S\-T\-R\-I\-N\-G\-\_\-\-H\-E\-A\-D\-E\-R}}
\index{A\-D\-S1256\-\_\-\-R\-E\-G\-I\-S\-T\-E\-R\-S\-\_\-\-T\-O\-S\-T\-R\-I\-N\-G\-\_\-\-H\-E\-A\-D\-E\-R@{A\-D\-S1256\-\_\-\-R\-E\-G\-I\-S\-T\-E\-R\-S\-\_\-\-T\-O\-S\-T\-R\-I\-N\-G\-\_\-\-H\-E\-A\-D\-E\-R}!ADS1256_Driver.c@{A\-D\-S1256\-\_\-\-Driver.\-c}}
\subsubsection[{A\-D\-S1256\-\_\-\-R\-E\-G\-I\-S\-T\-E\-R\-S\-\_\-\-T\-O\-S\-T\-R\-I\-N\-G\-\_\-\-H\-E\-A\-D\-E\-R}]{\setlength{\rightskip}{0pt plus 5cm}\#define A\-D\-S1256\-\_\-\-R\-E\-G\-I\-S\-T\-E\-R\-S\-\_\-\-T\-O\-S\-T\-R\-I\-N\-G\-\_\-\-H\-E\-A\-D\-E\-R~\char`\"{}\mbox{[}A\-D\-S1256\mbox{]} Register Contents\-:\textbackslash{}n\textbackslash{}r\char`\"{}}}\label{_a_d_s1256___driver_8c_aaa23b199dae1b52d4b78b56328e5509b}


Definition at line 79 of file A\-D\-S1256\-\_\-\-Driver.\-c.

